5.3 Cancelamento de boletos
Request
Request
mutation MarkToCancelBilling {
markToCancelBilling(
data: {
cancellationReason: BILLING_WRONG_VALUE
refId: "8e0c4a53-66cb-41b8-ab92-7be132437755"
}
) {
canceled
scheduled
billingId
}
}
Params
Parâmetro | Tipo | Descrição |
---|---|---|
data | CancelBillingDataInput! | Dados de inclusão da cobrança |
Objeto CancelBillingDataInput
Campo | Tipo | Descrição |
---|---|---|
auditData | AuditDataInput | Dados de auditoria do sistema integrado |
cancellationDescription | String | Descrição do motivo de cancelamento |
cancellationReason | CancellationReason | Motivo de cancelamento |
id | Int | Id da cobrança |
manualCancellation | Boolean | Cancelamento manual |
notes | String | Anotação |
refId | String | Id de referência |
scheduleCancellationIfNotRegistered | Boolean | Em caso de falha ao tentar o cancelamento, o sistema irá marcar a cobrança para ser cancelada posteriormente |
Response
Response
{
"data": {
"markToCancelBilling": {
"canceled": true,
"scheduled": false,
"billingId": null
}
}
}
Result
Campo | Tipo | Descrição |
---|---|---|
markToCancelBilling | CancelBillingResult! | Dados de retorno do cancelamento da cobrança |
Objeto CancelBillingResult
Campo | Tipo | Descrição |
---|---|---|
billingId | Int | Id único da cobrança |
canceled | Boolean! | Cobrança foi cancelada |
scheduled | Boolean! | Cobrança foi agendada para ser cancelada após o registro |